Skip to content

docs: document v3 migration and v6 beta changes - #80

Open
rustatian wants to merge 25 commits into
masterfrom
release/v3
Open

docs: document v3 migration and v6 beta changes#80
rustatian wants to merge 25 commits into
masterfrom
release/v3

Conversation

@rustatian

@rustatian rustatian commented Sep 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Document the v5-to-v6 plugin migration for the upcoming v3 release on release/v3.

Included Changes

  • Add a migration guide for HTTP middleware order, H2C, logging and rotation, removed RPC codecs/exporters, and TCP default-build removal.
  • Document named Jobs pools, the new NSQ driver, and broker/storage fixes.
  • Document named AMQP connections and nested-only YAML, including config.version removal and PHP queueHeaders connection selection.
  • Update gRPC reflection, Temporal worker capabilities, health checks, metrics, and tracing guidance.
  • Cover pool and Goridge changes, the api/api-go/api-plugins split, slog interfaces, and context-aware plugin contracts. Clarify the unchanged Endure and tcplisten requirements.
  • Replace obsolete Velox examples with a pinned v3 development build. Separate untagged PROXY protocol, static caching, pool, and Temporal changes from the selected beta versions.
  • Document Unix socket mode and ownership for all seven plugins. Explain empty options, validation, and FastCGI shutdown limits.
  • Document current beta limits, including BoltDB named-pool routing, memory expiration, allocation retry, and service restart behavior.
  • Include zstd middleware documentation for feat: add zstd HTTP middleware zstd#1.
  • Document bundled HTTP rate limiting from feat: add HTTP rate limiter middleware rate-limiter#1.
  • Correct startup instructions, CORS and upload restrictions, queue and lock guarantees, and PHP/Go API examples.
  • Repair the historical Lambda adapter mapping, execution limits, and bootstrap build.
  • Document the lock plugin Redis backend and its configuration (feat: add Redis lock backend lock#101).
  • Document deferred service configuration updates for [💡 FEATURE REQUEST]: Support updating service parameters using gRPC roadrunner#2119, including PHP support and release requirements.

Closed PRs

rustatian and others added 14 commits February 17, 2026 17:33
@rustatian
feature: v2 config amqp
e8a209d 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: update
a80bed9 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
Update queues/amqp.md
9dfe2b5 
Co-authored-by: Copilot <[email protected]>
@rustatian
chore: update doc
2b7597a 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: add what's next
2869d91 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: grpc interceptors docs
addd5cb 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: update docs
12ae6b4 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: update interceptors
0ab1def 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: update
4a3649d 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
chore: update grpc docs
8a72dd3 
Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian
docs(http): document static middleware cache options
4cb5d55 
New keys: prefixes, cache_ttl, cache_miss_ttl, cache_max_entries. Refresh the intro for the in-memory metadata/miss caching, the GET/HEAD method gate, and the weak-etag description (size + mtime).
@rustatian
docs: include AMQP and gRPC updates
9657abb
@rustatian
docs: include static middleware cache options
12699c9
@rustatian
docs(http): document zstd middleware
9208183
Copilot AI lite review requested due to automatic review settings September 6, 2026 10:54
Copilot AI reviewed Sep 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

There are a couple of documentation consistency/clarity issues (HTTP zstd page title format and static cache behavior description) that should be corrected to avoid confusing readers.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR consolidates and expands RoadRunner v3-related documentation by adding new docs pages/features (HTTP zstd middleware and gRPC interceptors) and updating existing pages to reflect newer configuration formats and behaviors.

Changes:

  • Added new documentation pages for HTTP zstd middleware and gRPC unary interceptors, and linked them from navigation and existing guides.
  • Reworked AMQP jobs pipeline documentation to describe versioned pipeline config formats (v2 nested exchange/queue vs legacy flat) and added operational notes (read-only RabbitMQ, RPC declaration behavior).
  • Updated HTTP docs to include zstd in the HTTP middleware reference and refreshed static middleware caching/ETag documentation.
File summaries
File Description
SUMMARY.md Adds nav entries for HTTP zstd and gRPC Interceptors.
queues/amqp.md Updates AMQP pipeline config docs (v2 nested format, legacy keys, permissions/RPC notes, migration/next links).
http/zstd.md New page documenting HTTP zstd middleware availability, config, and behavior.
http/static.md Updates static middleware docs with cache/prefix options and corrected ETag behavior description.
http/http.md Adds zstd to the allowed HTTP middleware list and notes build requirement.
grpc/interceptors.md New page documenting interceptor contract, config, ordering, and build examples.
grpc/grpc.md Adds a cross-link to the new interceptors documentation.
Review details
  • Files reviewed: 7/7 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread http/static.md Outdated
Comment thread http/zstd.md
@rustatian rustatian changed the title docs: consolidate v3 release documentation docs: document v3 migration and v6 beta changes Sep 6, 2026
@rustatian rustatian self-assigned this Sep 6, 2026
@rustatian rustatian added the documentation Improvements or additions to documentation label Sep 6, 2026
@rustatian rustatian mentioned this pull request Sep 8, 2026
Merged
@rustatian rustatian mentioned this pull request Sep 8, 2026
Merged
@rustatian
docs(lock): document the Redis lock backend configuration
c76c5e0 
The page now lists the two backends, every Redis configuration key, and the Redis lock contracts.
@rustatian
docs(service): document deferred configuration updates
8824f9c
@rustatian rustatian mentioned this pull request Sep 16, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

@rustatian rustatian

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rustatian